DOC: resolve all GL03 docstring validation errors #25525

jamescobonkerr · 2019-03-03T18:24:01Z

closes Fix validation error type GL03 and check in CI #25172
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

Original number of errors: 95
Remaining errors: 0

codecov · 2019-03-03T18:42:33Z

Codecov Report

Merging #25525 into master will decrease coverage by 50.03%.
The diff coverage is 75%.

@@             Coverage Diff             @@
##           master   #25525       +/-   ##
===========================================
- Coverage   91.75%   41.71%   -50.04%     
===========================================
  Files         173      173               
  Lines       52960    52960               
===========================================
- Hits        48595    22094    -26501     
- Misses       4365    30866    +26501

Flag	Coverage Δ
#multiple	`?`
#single	`41.71% <75%> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/io/feather_format.py	`89.74% <ø> (ø)`	⬆️
pandas/core/base.py	`33.33% <ø> (-64.43%)`	⬇️
pandas/core/frame.py	`34.79% <ø> (-62.07%)`	⬇️
pandas/core/generic.py	`37.92% <ø> (-56.25%)`	⬇️
pandas/plotting/_misc.py	`6.93% <ø> (-31.76%)`	⬇️
pandas/core/arrays/sparse.py	`40.24% <ø> (-51.93%)`	⬇️
pandas/core/indexes/base.py	`55.72% <ø> (-40.85%)`	⬇️
pandas/core/config.py	`61.12% <0%> (-25.92%)`	⬇️
pandas/core/groupby/base.py	`57.14% <100%> (-34.7%)`	⬇️
pandas/core/arrays/datetimes.py	`65.88% <100%> (-31.92%)`	⬇️
... and 141 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 42b4c97...a87f2e6. Read the comment docs.

codecov · 2019-03-03T18:42:35Z

Codecov Report

Merging #25525 into master will decrease coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #25525      +/-   ##
==========================================
- Coverage   91.26%   91.26%   -0.01%     
==========================================
  Files         173      173              
  Lines       52968    52967       -1     
==========================================
- Hits        48340    48338       -2     
- Misses       4628     4629       +1

Flag	Coverage Δ
#multiple	`89.83% <100%> (-0.01%)`	⬇️
#single	`41.71% <100%> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/io/feather_format.py	`89.74% <ø> (ø)`	⬆️
pandas/core/groupby/base.py	`91.83% <ø> (ø)`	⬆️
pandas/core/base.py	`97.76% <ø> (ø)`	⬆️
pandas/core/frame.py	`96.79% <ø> (ø)`	⬆️
pandas/core/generic.py	`93.65% <ø> (ø)`	⬆️
pandas/plotting/_misc.py	`38.68% <ø> (ø)`	⬆️
pandas/core/config.py	`87% <ø> (-0.05%)`	⬇️
pandas/core/groupby/groupby.py	`97.2% <ø> (ø)`	⬆️
pandas/core/arrays/sparse.py	`92.17% <ø> (ø)`	⬆️
pandas/core/indexes/base.py	`96.57% <ø> (ø)`	⬆️
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cc4a7e5...6e79af0. Read the comment docs.

jamescobonkerr · 2019-03-03T18:44:07Z

Original errors:

pandas.Series.to_numpy: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.agg: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.aggregate: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.cummax: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.cummin: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.cumprod: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.cumsum: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.kurt: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.mad: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.mean: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.median: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.skew: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.kurtosis: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.compound: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.dayofweek: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.weekday: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_month_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_month_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_quarter_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_quarter_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_year_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_year_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_leap_year: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.SparseArray: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.read_feather: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.resample.Resampler.apply: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.resample.Resampler.aggregate: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.resample.Resampler.pipe: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.resample.Resampler.mean: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.cummax: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.cummin: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.cumprod: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.cumsum: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.mean: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.median: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.skew: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.swaplevel: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.plotting.andrews_curves: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.describe_option: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.reset_option: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.get_option: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.set_option: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.melt: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Index.reindex: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.dayofweek: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.weekday: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_month_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_month_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_quarter_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_quarter_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_year_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_year_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_leap_year: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.window.Rolling.aggregate: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.window.Expanding.aggregate: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.GroupBy.head: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.GroupBy.mean: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.GroupBy.nth: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.GroupBy.tail: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.corr: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.cov: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.diff: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.fillna: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.hist: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.idxmax: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.idxmin: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.mad: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.skew: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.take: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.tshift: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.SeriesGroupBy.nlargest: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.SeriesGroupBy.nsmallest: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.SeriesGroupBy.unique: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.corrwith: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.agg: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.aggregate: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.compound: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.cummax: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.cummin: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.cumprod: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.cumsum: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.kurt: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.kurtosis: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.mad: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.mean: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.median: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.skew: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.to_html: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.ptp: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.compound: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.kurt: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.kurtosis: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.mad: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings

TomAugspurger · 2019-03-03T19:53:26Z

Thanks. Looks like a few more https://dev.azure.com/pandas-dev/pandas/_build/results?buildId=8945&view=logs&jobId=10b0523a-38de-5c7a-02e7-c2259d583b33&taskId=1a0a9012-bae2-55d5-f263-1897ae870737&lineStart=26&lineEnd=27&colStart=1&colEnd=1

Let us know if you need help finishing this off.

TomAugspurger · 2019-03-03T19:53:52Z

Actually, those are different errors (PR04). Haven't looked close yet at why those are showing up here.

jamescobonkerr · 2019-03-09T16:59:13Z

Thanks @TomAugspurger . Should be good to go now.

pandas/core/generic.py

pandas/core/groupby/groupby.py

pandas/core/generic.py

WillAyd

lgtm @TomAugspurger

TomAugspurger · 2019-03-10T21:08:35Z

Thanks!

jamescobonkerr force-pushed the fix-gl03 branch from e2d061d to a87f2e6 Compare March 3, 2019 18:42

TomAugspurger added the Docs label Mar 3, 2019

TomAugspurger added this to the 0.25.0 milestone Mar 3, 2019

jamescobonkerr added 5 commits March 9, 2019 16:14

Resolve GL03 docstring validation errors

f750975

Update code_checks.sh to validate GL03

19a2a54

Remove newline concat in _build_option_description function

4a29b06

Resolve PR04 errors

b497384

Resolve remaining SS04 errors

754336e

jamescobonkerr force-pushed the fix-gl03 branch from 3d23a42 to 754336e Compare March 9, 2019 16:16

WillAyd requested changes Mar 9, 2019

View reviewed changes

pandas/core/generic.py Outdated Show resolved Hide resolved

pandas/core/generic.py Show resolved Hide resolved

Remove newline from end of _cnum_doc string

c7ad2e7

WillAyd requested changes Mar 9, 2019

View reviewed changes

pandas/core/generic.py Outdated Show resolved Hide resolved

pandas/core/groupby/groupby.py Outdated Show resolved Hide resolved

pandas/core/generic.py Show resolved Hide resolved

Move terminating quotes to same line to avoid line breaks

6e79af0

WillAyd approved these changes Mar 10, 2019

View reviewed changes

TomAugspurger merged commit 34e8efe into pandas-dev:master Mar 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

DOC: resolve all GL03 docstring validation errors #25525

DOC: resolve all GL03 docstring validation errors #25525

Uh oh!

jamescobonkerr commented Mar 3, 2019 •

edited

Loading

Uh oh!

codecov bot commented Mar 3, 2019

Uh oh!

codecov bot commented Mar 3, 2019 •

edited

Loading

Uh oh!

jamescobonkerr commented Mar 3, 2019

Uh oh!

TomAugspurger commented Mar 3, 2019

Uh oh!

TomAugspurger commented Mar 3, 2019

Uh oh!

jamescobonkerr commented Mar 9, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

WillAyd left a comment

Uh oh!

TomAugspurger commented Mar 10, 2019

Uh oh!

Uh oh!

Uh oh!

DOC: resolve all GL03 docstring validation errors #25525

DOC: resolve all GL03 docstring validation errors #25525

Uh oh!

Conversation

jamescobonkerr commented Mar 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 3, 2019

Codecov Report

Uh oh!

codecov bot commented Mar 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jamescobonkerr commented Mar 3, 2019

Uh oh!

TomAugspurger commented Mar 3, 2019

Uh oh!

TomAugspurger commented Mar 3, 2019

Uh oh!

jamescobonkerr commented Mar 9, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

WillAyd left a comment

Choose a reason for hiding this comment

Uh oh!

TomAugspurger commented Mar 10, 2019

Uh oh!

Uh oh!

jamescobonkerr commented Mar 3, 2019 •

edited

Loading

codecov bot commented Mar 3, 2019 •

edited

Loading